﻿#region Copyright
// Copyright (c) 2011-2012 RaisingForce Team (Alikin Sergey)
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
#endregion

using RaisingForce.Raise.Measures;

namespace RaisingForce.Raise.Hardware
{
    /// <summary>
    /// Представляет интерфейс доступа к ультразвуковому датчику робота.
    /// </summary>
    /// <remarks>
    /// Все методы и свойства интерфейса могут быть вызваны асинхронно
    /// из разных потоков для объекта, реализующего интерфейс.
    /// Требуется обеспечить их потокобезопасность.
    /// <para>Для упрощения реализации интерфейса следует унаследовать
    /// класс реализации от абстрактного класса <see cref="RobotSensor"/>.</para>
    /// </remarks>
    /// <seealso cref="IRobotHardware"/>
    public interface IRobotSensor
    {
        /// <summary>
        /// Определяет расстояние до ближайшего препятствия,
        /// расположенного прямо перед роботом, с помощью ультразвукового датчика.
        /// </summary>
        /// <returns>Расстояние до ближайшего препятствия,
        /// или Distance.Unknown, если препятствие не обнаружено.</returns>
        /// <exception cref="RobotHardwareException">
        /// Произошла ошибка с оборудованием, либо робот не ответил вовремя.
        /// </exception>
        /// <remarks>
        /// <para>Данный метод должен опросить ультразвуковой датчик,
        /// дождаться ответа и вернуть ожидаемый результат.
        /// Метод вызывается всегда после того, как соединение с роботом
        /// было установлено методом <c>IRobotHardware.Connect()</c>.</para>
        /// <para>В процессе ожидания ответа от робота метод должен тратить минимум
        /// процессорного времени, передавая управление другим потокам
        /// с помощью метода <c>System.Threading.Thread.Sleep()</c>.</para>
        /// <para>В случае невозможности успешного выполнения задачи
        /// (например из-за ошибки с оборудованием робота)
        /// метод должен выбрасывать исключение <c>RobotHardwareException</c>.
        /// Другие типы исключений недопустимы.</para>
        /// </remarks>
        /// <seealso cref="IRobotSensor"/>
        /// <seealso cref="IRobotHardware"/>
        /// <seealso cref="RobotHardwareException"/>
        /// <seealso cref="System.Threading.Thread"/>
        Distance DetectObstacle();
    }
}
